Skip to content

Conversation

@lucy66hw
Copy link
Contributor

@lucy66hw lucy66hw commented Jan 15, 2026

The OpenAPI Normalizer wraps $ref with sibling properties (title, description) inside allOf constructs. The Protobuf generator wasn't properly unwrapping these single-item allOf containers, causing issues when handling complex types within oneOf.
expected:

Pet:
  oneOf:
    - allOf:  
        - $ref: '#/components/schemas/Dog'
      title: dog
      description: "A dog pet"
    - allOf:  
        - $ref: '#/components/schemas/Cat'
      title: cat
      description: "A cat pet"
    - allOf:  
        - $ref: '#/components/schemas/Bird'
      title: bird
      description: "A bird pet"

solution:
Unwrap single-item allOf: If the resolved schema is allOf with exactly one item, unwrap it.

Pet:
  oneOf:
    - title: dog  
      description: "A dog pet"
      $ref: '#/components/schemas/Dog'
    - title: cat  
      description: "A cat pet"
      $ref: '#/components/schemas/Cat'
    - title: bird  
      description: "A bird pet"
      $ref: '#/components/schemas/Bird'

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@lucy66hw lucy66hw marked this pull request as ready for review January 15, 2026 07:30
Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 3 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="modules/openapi-generator/src/test/java/org/openapitools/codegen/protobuf/ProtobufSchemaCodegenTest.java">

<violation number="1" location="modules/openapi-generator/src/test/java/org/openapitools/codegen/protobuf/ProtobufSchemaCodegenTest.java:192">
P2: Test does not fail for unexpected var names; missing else/set-membership assertion allows false positives.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@wing328
Copy link
Member

wing328 commented Jan 19, 2026

circleci failure not related to this change

@wing328
Copy link
Member

wing328 commented Jan 19, 2026

thanks for the PR

let's give it a try

in the next release (v7.20.0) i may add an option to opt out of the allOf normalization to handle $ref with sibling properties in 3.1 spec as not all generators can handle such case at the moment

@wing328 wing328 merged commit 24242be into OpenAPITools:master Jan 19, 2026
14 of 15 checks passed
@wing328 wing328 added this to the 7.19.0 milestone Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants